home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / src / linux-headers-2.6.28-15 / include / linux / rio.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-24  |  10.6 KB  |  335 lines
  1. /*
  2.  * RapidIO interconnect services
  3.  * (RapidIO Interconnect Specification, http://www.rapidio.org)
  4.  *
  5.  * Copyright 2005 MontaVista Software, Inc.
  6.  * Matt Porter <mporter@kernel.crashing.org>
  7.  *
  8.  * This program is free software; you can redistribute  it and/or modify it
  9.  * under  the terms of  the GNU General  Public License as published by the
  10.  * Free Software Foundation;  either version 2 of the  License, or (at your
  11.  * option) any later version.
  12.  */
  13.  
  14. #ifndef LINUX_RIO_H
  15. #define LINUX_RIO_H
  16.  
  17. #include <linux/types.h>
  18. #include <linux/ioport.h>
  19. #include <linux/list.h>
  20. #include <linux/errno.h>
  21. #include <linux/device.h>
  22. #include <linux/rio_regs.h>
  23.  
  24. #define RIO_NO_HOPCOUNT        -1
  25. #define RIO_INVALID_DESTID    0xffff
  26.  
  27. #define RIO_MAX_MPORT_RESOURCES    16
  28. #define RIO_MAX_DEV_RESOURCES    16
  29.  
  30. #define RIO_GLOBAL_TABLE    0xff    /* Indicates access of a switch's
  31.                        global routing table if it
  32.                        has multiple (or per port)
  33.                        tables */
  34.  
  35. #define RIO_INVALID_ROUTE    0xff    /* Indicates that a route table
  36.                        entry is invalid (no route
  37.                        exists for the device ID) */
  38.  
  39. #define RIO_MAX_ROUTE_ENTRIES(size)    (size ? (1 << 16) : (1 << 8))
  40. #define RIO_ANY_DESTID(size)        (size ? 0xffff : 0xff)
  41.  
  42. #define RIO_MAX_MBOX        4
  43. #define RIO_MAX_MSG_SIZE    0x1000
  44.  
  45. /*
  46.  * Error values that may be returned by RIO functions.
  47.  */
  48. #define RIO_SUCCESSFUL            0x00
  49. #define RIO_BAD_SIZE            0x81
  50.  
  51. /*
  52.  * For RIO devices, the region numbers are assigned this way:
  53.  *
  54.  *    0    RapidIO outbound doorbells
  55.  *      1-15    RapidIO memory regions
  56.  *
  57.  * For RIO master ports, the region number are assigned this way:
  58.  *
  59.  *    0    RapidIO inbound doorbells
  60.  *    1    RapidIO inbound mailboxes
  61.  *    1    RapidIO outbound mailboxes
  62.  */
  63. #define RIO_DOORBELL_RESOURCE    0
  64. #define RIO_INB_MBOX_RESOURCE    1
  65. #define RIO_OUTB_MBOX_RESOURCE    2
  66.  
  67. extern struct bus_type rio_bus_type;
  68. extern struct list_head rio_devices;    /* list of all devices */
  69.  
  70. struct rio_mport;
  71.  
  72. /**
  73.  * struct rio_dev - RIO device info
  74.  * @global_list: Node in list of all RIO devices
  75.  * @net_list: Node in list of RIO devices in a network
  76.  * @net: Network this device is a part of
  77.  * @did: Device ID
  78.  * @vid: Vendor ID
  79.  * @device_rev: Device revision
  80.  * @asm_did: Assembly device ID
  81.  * @asm_vid: Assembly vendor ID
  82.  * @asm_rev: Assembly revision
  83.  * @efptr: Extended feature pointer
  84.  * @pef: Processing element features
  85.  * @swpinfo: Switch port info
  86.  * @src_ops: Source operation capabilities
  87.  * @dst_ops: Destination operation capabilities
  88.  * @dma_mask: Mask of bits of RIO address this device implements
  89.  * @rswitch: Pointer to &struct rio_switch if valid for this device
  90.  * @driver: Driver claiming this device
  91.  * @dev: Device model device
  92.  * @riores: RIO resources this device owns
  93.  * @destid: Network destination ID
  94.  */
  95. struct rio_dev {
  96.     struct list_head global_list;    /* node in list of all RIO devices */
  97.     struct list_head net_list;    /* node in per net list */
  98.     struct rio_net *net;    /* RIO net this device resides in */
  99.     u16 did;
  100.     u16 vid;
  101.     u32 device_rev;
  102.     u16 asm_did;
  103.     u16 asm_vid;
  104.     u16 asm_rev;
  105.     u16 efptr;
  106.     u32 pef;
  107.     u32 swpinfo;        /* Only used for switches */
  108.     u32 src_ops;
  109.     u32 dst_ops;
  110.     u64 dma_mask;
  111.     struct rio_switch *rswitch;    /* RIO switch info */
  112.     struct rio_driver *driver;    /* RIO driver claiming this device */
  113.     struct device dev;    /* LDM device structure */
  114.     struct resource riores[RIO_MAX_DEV_RESOURCES];
  115.     u16 destid;
  116. };
  117.  
  118. #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
  119. #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
  120. #define    to_rio_dev(n) container_of(n, struct rio_dev, dev)
  121.  
  122. /**
  123.  * struct rio_msg - RIO message event
  124.  * @res: Mailbox resource
  125.  * @mcback: Message event callback
  126.  */
  127. struct rio_msg {
  128.     struct resource *res;
  129.     void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
  130. };
  131.  
  132. /**
  133.  * struct rio_dbell - RIO doorbell event
  134.  * @node: Node in list of doorbell events
  135.  * @res: Doorbell resource
  136.  * @dinb: Doorbell event callback
  137.  * @dev_id: Device specific pointer to pass on event
  138.  */
  139. struct rio_dbell {
  140.     struct list_head node;
  141.     struct resource *res;
  142.     void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
  143.     void *dev_id;
  144. };
  145.  
  146. enum rio_phy_type {
  147.     RIO_PHY_PARALLEL,
  148.     RIO_PHY_SERIAL,
  149. };
  150.  
  151. /**
  152.  * struct rio_mport - RIO master port info
  153.  * @dbells: List of doorbell events
  154.  * @node: Node in global list of master ports
  155.  * @nnode: Node in network list of master ports
  156.  * @iores: I/O mem resource that this master port interface owns
  157.  * @riores: RIO resources that this master port interfaces owns
  158.  * @inb_msg: RIO inbound message event descriptors
  159.  * @outb_msg: RIO outbound message event descriptors
  160.  * @host_deviceid: Host device ID associated with this master port
  161.  * @ops: configuration space functions
  162.  * @id: Port ID, unique among all ports
  163.  * @index: Port index, unique among all port interfaces of the same type
  164.  * @sys_size: RapidIO common transport system size
  165.  * @phy_type: RapidIO phy type
  166.  * @name: Port name string
  167.  * @priv: Master port private data
  168.  */
  169. struct rio_mport {
  170.     struct list_head dbells;    /* list of doorbell events */
  171.     struct list_head node;    /* node in global list of ports */
  172.     struct list_head nnode;    /* node in net list of ports */
  173.     struct resource iores;
  174.     struct resource riores[RIO_MAX_MPORT_RESOURCES];
  175.     struct rio_msg inb_msg[RIO_MAX_MBOX];
  176.     struct rio_msg outb_msg[RIO_MAX_MBOX];
  177.     int host_deviceid;    /* Host device ID */
  178.     struct rio_ops *ops;    /* maintenance transaction functions */
  179.     unsigned char id;    /* port ID, unique among all ports */
  180.     unsigned char index;    /* port index, unique among all port
  181.                    interfaces of the same type */
  182.     unsigned int sys_size;    /* RapidIO common transport system size.
  183.                  * 0 - Small size. 256 devices.
  184.                  * 1 - Large size, 65536 devices.
  185.                  */
  186.     enum rio_phy_type phy_type;    /* RapidIO phy type */
  187.     unsigned char name[40];
  188.     void *priv;        /* Master port private data */
  189. };
  190.  
  191. /**
  192.  * struct rio_net - RIO network info
  193.  * @node: Node in global list of RIO networks
  194.  * @devices: List of devices in this network
  195.  * @mports: List of master ports accessing this network
  196.  * @hport: Default port for accessing this network
  197.  * @id: RIO network ID
  198.  */
  199. struct rio_net {
  200.     struct list_head node;    /* node in list of networks */
  201.     struct list_head devices;    /* list of devices in this net */
  202.     struct list_head mports;    /* list of ports accessing net */
  203.     struct rio_mport *hport;    /* primary port for accessing net */
  204.     unsigned char id;    /* RIO network ID */
  205. };
  206.  
  207. /**
  208.  * struct rio_switch - RIO switch info
  209.  * @node: Node in global list of switches
  210.  * @switchid: Switch ID that is unique across a network
  211.  * @hopcount: Hopcount to this switch
  212.  * @destid: Associated destid in the path
  213.  * @route_table: Copy of switch routing table
  214.  * @add_entry: Callback for switch-specific route add function
  215.  * @get_entry: Callback for switch-specific route get function
  216.  */
  217. struct rio_switch {
  218.     struct list_head node;
  219.     u16 switchid;
  220.     u16 hopcount;
  221.     u16 destid;
  222.     u8 *route_table;
  223.     int (*add_entry) (struct rio_mport * mport, u16 destid, u8 hopcount,
  224.               u16 table, u16 route_destid, u8 route_port);
  225.     int (*get_entry) (struct rio_mport * mport, u16 destid, u8 hopcount,
  226.               u16 table, u16 route_destid, u8 * route_port);
  227. };
  228.  
  229. /* Low-level architecture-dependent routines */
  230.  
  231. /**
  232.  * struct rio_ops - Low-level RIO configuration space operations
  233.  * @lcread: Callback to perform local (master port) read of config space.
  234.  * @lcwrite: Callback to perform local (master port) write of config space.
  235.  * @cread: Callback to perform network read of config space.
  236.  * @cwrite: Callback to perform network write of config space.
  237.  * @dsend: Callback to send a doorbell message.
  238.  */
  239. struct rio_ops {
  240.     int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
  241.             u32 *data);
  242.     int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
  243.             u32 data);
  244.     int (*cread) (struct rio_mport *mport, int index, u16 destid,
  245.             u8 hopcount, u32 offset, int len, u32 *data);
  246.     int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
  247.             u8 hopcount, u32 offset, int len, u32 data);
  248.     int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
  249. };
  250.  
  251. #define RIO_RESOURCE_MEM    0x00000100
  252. #define RIO_RESOURCE_DOORBELL    0x00000200
  253. #define RIO_RESOURCE_MAILBOX    0x00000400
  254.  
  255. #define RIO_RESOURCE_CACHEABLE    0x00010000
  256. #define RIO_RESOURCE_PCI    0x00020000
  257.  
  258. #define RIO_RESOURCE_BUSY    0x80000000
  259.  
  260. /**
  261.  * struct rio_driver - RIO driver info
  262.  * @node: Node in list of drivers
  263.  * @name: RIO driver name
  264.  * @id_table: RIO device ids to be associated with this driver
  265.  * @probe: RIO device inserted
  266.  * @remove: RIO device removed
  267.  * @suspend: RIO device suspended
  268.  * @resume: RIO device awakened
  269.  * @enable_wake: RIO device enable wake event
  270.  * @driver: LDM driver struct
  271.  *
  272.  * Provides info on a RIO device driver for insertion/removal and
  273.  * power management purposes.
  274.  */
  275. struct rio_driver {
  276.     struct list_head node;
  277.     char *name;
  278.     const struct rio_device_id *id_table;
  279.     int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
  280.     void (*remove) (struct rio_dev * dev);
  281.     int (*suspend) (struct rio_dev * dev, u32 state);
  282.     int (*resume) (struct rio_dev * dev);
  283.     int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
  284.     struct device_driver driver;
  285. };
  286.  
  287. #define    to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
  288.  
  289. /**
  290.  * struct rio_device_id - RIO device identifier
  291.  * @did: RIO device ID
  292.  * @vid: RIO vendor ID
  293.  * @asm_did: RIO assembly device ID
  294.  * @asm_vid: RIO assembly vendor ID
  295.  *
  296.  * Identifies a RIO device based on both the device/vendor IDs and
  297.  * the assembly device/vendor IDs.
  298.  */
  299. struct rio_device_id {
  300.     u16 did, vid;
  301.     u16 asm_did, asm_vid;
  302. };
  303.  
  304. /**
  305.  * struct rio_route_ops - Per-switch route operations
  306.  * @vid: RIO vendor ID
  307.  * @did: RIO device ID
  308.  * @add_hook: Callback that adds a route entry
  309.  * @get_hook: Callback that gets a route entry
  310.  *
  311.  * Defines the operations that are necessary to manipulate the route
  312.  * tables for a particular RIO switch device.
  313.  */
  314. struct rio_route_ops {
  315.     u16 vid, did;
  316.     int (*add_hook) (struct rio_mport * mport, u16 destid, u8 hopcount,
  317.              u16 table, u16 route_destid, u8 route_port);
  318.     int (*get_hook) (struct rio_mport * mport, u16 destid, u8 hopcount,
  319.              u16 table, u16 route_destid, u8 * route_port);
  320. };
  321.  
  322. /* Architecture and hardware-specific functions */
  323. extern int rio_init_mports(void);
  324. extern void rio_register_mport(struct rio_mport *);
  325. extern int rio_hw_add_outb_message(struct rio_mport *, struct rio_dev *, int,
  326.                    void *, size_t);
  327. extern int rio_hw_add_inb_buffer(struct rio_mport *, int, void *);
  328. extern void *rio_hw_get_inb_message(struct rio_mport *, int);
  329. extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
  330. extern void rio_close_inb_mbox(struct rio_mport *, int);
  331. extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
  332. extern void rio_close_outb_mbox(struct rio_mport *, int);
  333.  
  334. #endif                /* LINUX_RIO_H */
  335.